Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

refactor(progress): generic progress tracking #1524

Open
wants to merge 14 commits into
base: main
Choose a base branch
from
Open

refactor(progress): generic progress tracking #1524

wants to merge 14 commits into from

Conversation

shizhMSFT
Copy link
Contributor

@shizhMSFT shizhMSFT commented Nov 1, 2024 •
edited
Loading

This PR is an implementation of oras-project/oras-go#839.

The goal is to refactor the core code of progress reporting from the oras CLI code base in order to put it into oras-go for others to implement their own progress reporting method.

The refactored code is in the internal/progress package.

@shizhMSFT shizhMSFT added the experimental Issues or pull requests depending on WIP specs label Nov 1, 2024
@shizhMSFT shizhMSFT mentioned this pull request Nov 1, 2024
Open
@github-actions GitHub Actions
Copy link

This PR is stale because it has been open 45 days with no activity. Remove stale label or comment or this will be closed in 30 days.

@github-actions github-actions bot added the stale Inactive issues or pull requests label Dec 17, 2024
@shizhMSFT
feat: add track manager
cb1b6b5 
Signed-off-by: Shiwei Zhang <[email protected]>
@shizhMSFT
feat: use new track
227c041 
Signed-off-by: Shiwei Zhang <[email protected]>
@shizhMSFT
refactor: new reader
c9dea08 
Signed-off-by: Shiwei Zhang <[email protected]>
@shizhMSFT
doc: improve the doc for Record
76ff766 
Signed-off-by: Shiwei Zhang <[email protected]>
@shizhMSFT
refactor: better tracker
ae3f351 
Signed-off-by: Shiwei Zhang <[email protected]>
@shizhMSFT
nit: formatting
1a7b303 
Signed-off-by: Shiwei Zhang <[email protected]>
@shizhMSFT shizhMSFT removed the stale Inactive issues or pull requests label Dec 30, 2024
@shizhMSFT
feat!: migrate to the new progress package
d327a75 
Signed-off-by: Shiwei Zhang <[email protected]>
@shizhMSFT
fix: fix bugs and tests
5246e26 
Signed-off-by: Shiwei Zhang <[email protected]>
@shizhMSFT
fix: fix status
4947bb6 
Signed-off-by: Shiwei Zhang <[email protected]>
@codecov Codecov
Copy link

codecov bot commented Dec 30, 2024 •
edited
Loading

Codecov Report

Attention: Patch coverage is 82.09607% with 41 lines in your changes missing coverage. Please review.

Project coverage is 84.16%. Comparing base (836c497) to head (f8503f9).
Report is 1 commits behind head on main.

Files with missing lines Patch % Lines
cmd/oras/internal/display/status/track/target.go 48.27% 10 Missing and 5 partials ⚠️
cmd/oras/root/blob/fetch.go 0.00% 4 Missing and 2 partials ⚠️
...md/oras/internal/display/status/progress/status.go 87.50% 5 Missing ⚠️
...oras/internal/display/status/progress/messenger.go 82.60% 3 Missing and 1 partial ⚠️
cmd/oras/root/blob/push.go 20.00% 2 Missing and 2 partials ⚠️
internal/progress/tracker.go 94.28% 3 Missing and 1 partial ⚠️
cmd/oras/internal/display/status/tty.go 90.32% 3 Missing ⚠️
Additional details and impacted files 
@@            Coverage Diff             @@
##             main    #1524      +/-   ##
==========================================
- Coverage   84.34%   84.16%   -0.19%     
==========================================
  Files         120      121       +1     
  Lines        5449     5557     +108     
==========================================
+ Hits         4596     4677      +81     
- Misses        606      627      +21     
- Partials      247      253       +6

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@shizhMSFT shizhMSFT marked this pull request as ready for review December 31, 2024 09:51
@shizhMSFT
Copy link
Contributor Author

shizhMSFT commented Dec 31, 2024 •
edited
Loading

Now we have a failure mark on error:
image

@shizhMSFT shizhMSFT changed the title refactor(oras-go): generic progress tracking refactor(progress): generic progress tracking Dec 31, 2024
@shizhMSFT shizhMSFT mentioned this pull request Dec 31, 2024
Draft
Wwwsylvia
Wwwsylvia reviewed Jan 6, 2025
View reviewed changes
Copy link
Member

@Wwwsylvia Wwwsylvia left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Built the code and tested a little bit. Got "panic: send on closed channel" error when running oras push localhost:5000/test:v1 foo.

cmd/oras/internal/display/status/tty.go
progress.StateTransmitting: PullPromptDownloading,
progress.StateTransmitted: PullPromptPulled,
progress.StateSkipped: PullPromptSkipped,
progress.StateMounted: PullPromptRestored,
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just a note: This is a bit tricky, is "mounted" a "restored" the same idea in the pull context? If so, wondering if there is a better prompt than "restored".

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@Wwwsylvia Wwwsylvia Wwwsylvia left review comments

@sajayantony sajayantony Awaiting requested review from sajayantony sajayantony is a code owner

@SteveLasker SteveLasker Awaiting requested review from SteveLasker SteveLasker is a code owner

@qweeah qweeah Awaiting requested review from qweeah qweeah is a code owner

@TerryHowe TerryHowe Awaiting requested review from TerryHowe TerryHowe is a code owner

At least 1 approving review is required to merge this pull request.

Assignees
No one assigned
Labels
experimental Issues or pull requests depending on WIP specs
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@shizhMSFT @Wwwsylvia